Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Serialization support for FlavorResource, FlavorResourceSet and FlavorResourceQuantities #4420

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

nasedil
Copy link

@nasedil nasedil commented Feb 26, 2025

What type of PR is this?

What this PR does / why we need it:

Properly serializes FlavorResource, FlavorResourceSet and FlavorResourceQuantities types which are logged in integration tests.

Which issue(s) this PR fixes:

Fixes #4137

Special notes for your reviewer:

As discussed in #4137 part of this issue depends on making serializable k8s.io/apimachinery/pkg/util/sets.Set in upstream repo. In the second commit I created FlavorResourceSet type to make it work without changing upstream code. Possible options are to keep it temporarily until upstream is fixed, keep it permanently, or just discart and keep only the first commit and wait till upstream issue is fixed.

Does this PR introduce a user-facing change?

NONE

@k8s-ci-robot k8s-ci-robot added the release-note-none Denotes a PR that doesn't merit a release note. label Feb 26, 2025
Copy link

linux-foundation-easycla bot commented Feb 26, 2025

CLA Signed

The committers listed above are authorized under a signed CLA.

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: nasedil
Once this PR has been reviewed and has the lgtm label, please assign tenzen-y for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot
Copy link
Contributor

Welcome @nasedil!

It looks like this is your first PR to kubernetes-sigs/kueue 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/kueue has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Feb 26, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @nasedil. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Feb 26, 2025
Copy link

netlify bot commented Feb 26, 2025

Deploy Preview for kubernetes-sigs-kueue canceled.

Name Link
🔨 Latest commit 64eed78
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-sigs-kueue/deploys/67c047911bdc8a000837e580

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Feb 26, 2025
Comment on lines 73 to 95
frsNeedPreemption sets.Set[resources.FlavorResource]
frsNeedPreemption FlavorResourceSet
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do not think we should do for logging. Instead of that, why we can not just use slice?

frsNeedPreemption.UnsortedList()

@mimowo Did you indicate JsonMarshal proposed in this PR? If yes, what is the reason not to use slice?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, my suggestion was to use slice rather than Json, for sure. I was just thinking about exposing this via String function, but frsNeedPreemption.UnsortedList() is also neat. I'm ok either way.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually yes, it looks like logger manages to marshal frsNeedPreemption.UnsortedList() just fine, and using String() for FlavorResourceSet I still need to do marshalling somehow. So I can substitute frsNeedPreemption with frsNeedPreemption.UnsortedList() in klog calls just fine. Moreover, it works even when FlavorResource and FlavorResourceQuantities do not implements String().

However the line

logV.Info("Workload evaluated for admission", args...)
still leads to the "json: unsupported type: resources.FlavorResourceQuantities" error (even when FlavorResource and FlavorResourceQuantities implement String()). And even if I implement JsonMarshal for them it would not output as nicely as it works . Looks like there is some functionality in klog that nicely formats to json that should be used, not sure why it doesn't pick up in this case.

I also see klog.KObj(preemptionCtx.preemptor.Obj) in klog calls, maybe this could be relevant?

Copy link
Contributor

@mimowo mimowo Feb 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

still leads to the "json: unsupported type: resources.FlavorResourceQuantities" error (even when FlavorResource and FlavorResourceQuantities implement String())

Yeah, this is surprising - I was assuming adding String() for resources.FlavorResourceQuantities would be enough, as the logger should check the input type implementes the Stringer interface and call String(), we had a similar case here: kubernetes/kubernetes#121392 (comment)

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can trace that e.assignment is passed to the logger here:

args = append(args, "nominatedAssignment", e.assignment)

where e is of type entry.

The type entry is defined here:

type entry struct {
// workload.Info holds the workload from the API as well as resource usage
// and flavors assigned.
workload.Info
dominantResourceShare int
dominantResourceName corev1.ResourceName
assignment flavorassigner.Assignment
status entryStatus
inadmissibleMsg string
requeueReason queue.RequeueReason
preemptionTargets []*preemption.Target
}

And e.assignment is of type Assignment from here:

type Assignment struct {
PodSets []PodSetAssignment
Borrowing bool
LastState workload.AssignmentClusterQueueState
// Usage is the accumulated Usage of resources as pod sets get
// flavors assigned.
Usage resources.FlavorResourceQuantities
// representativeMode is the cached representative mode for this assignment.
representativeMode *FlavorAssignmentMode
}

which uses FlavorResourceQuantities which are type FlavorResourceQuantities map[FlavorResource]int64. And FlavorResource is serialized fine in frsNeedPreemption.UnsortedList().

Maybe logger supports structs like:

type FlavorResource struct {
	Flavor   kueue.ResourceFlavorReference
	Resource corev1.ResourceName
}

But not map[FlavorResource]int64 out of the box? That's just one guess.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if this helps much, but you can setup also debugger in vs-code for the integration tests.

My setup for the settings.json in vs-code you just need to set:

    "go.testEnvVars": {
        "KUBEBUILDER_ASSETS": "/usr/local/..**../kubebuilder-envtest/k8s/1.28.3-linux-amd64",
    },

The full value of the var for your setup should be printed when invoking make test-integration target.

@mbobrovskyi
Copy link
Contributor

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Feb 27, 2025
The wrapper makes logger calls with sets.Set[resources.FlavorResource] serializable, without changing sets.Set upstream.
Removed redundant FlavorResourceSet type and associated marshaling methods because `klog` manages to serialize `frsNeedPreemption.UnsortedList()` properly.
@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Feb 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note-none Denotes a PR that doesn't merit a release note. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Problem serializing some Kueue types for logging
5 participants